Compose Media Player

Compose Media Player/io.github.kdroidfilter.composemediaplayer/[jvm]DefaultVideoPlayerState

DefaultVideoPlayerState

@Stable

open class DefaultVideoPlayerState : VideoPlayerState

Represents the state and behavior of a video player. This class provides properties and methods to control video playback, manage the playback state, and interact with platform-specific implementations.

Properties:

isPlaying: Indicates whether the video is currently playing.
volume: Controls the playback volume. Valid values are within the range of 0.0 (muted) to 1.0 (maximum volume).
sliderPos: Represents the current playback position as a normalized value between 0.0 and 1.0.
userDragging: Denotes whether the user is manually adjusting the playback position.
loop: Specifies if the video should loop when it reaches the end.
leftLevel: Provides the audio level for the left channel as a percentage.
rightLevel: Provides the audio level for the right channel as a percentage.
positionText: Returns the current playback position as a formatted string.
durationText: Returns the total duration of the video as a formatted string.

Methods:

openUri(uri: String): Opens a video file or URL for playback.
play(): Starts or resumes video playback.
pause(): Pauses video playback.
stop(): Stops playback and resets the player state.
seekTo(value: Float): Seeks to a specific playback position based on the provided normalized value.
dispose(): Releases resources used by the video player and disposes of the state.

Constructors

DefaultVideoPlayerState

constructor()

Properties

open override val aspectRatio: Float

availableSubtitleTracks

open override val availableSubtitleTracks: MutableList<SubtitleTrack>

currentSubtitleTrack

open override var currentSubtitleTrack: SubtitleTrack?

open override val currentTime: Double

val delegate: VideoPlayerState

open override val durationText: String

Returns the total duration of the video as a formatted string.

open override val error: VideoPlayerError?

open override val hasMedia: Boolean

open override var isFullscreen: Boolean

open override val isLoading: Boolean

open override val isPlaying: Boolean

Indicates whether the video is currently playing.

open override val leftLevel: Float

Provides the audio level for the left channel as a percentage.

open override var loop: Boolean

Specifies if the video should loop when it reaches the end.

open override val metadata: VideoMetadata

open override var playbackSpeed: Float

open override val positionText: String

Returns the current playback position as a formatted string.

open override val rightLevel: Float

Provides the audio level for the right channel as a percentage.

open override var sliderPos: Float

Represents the current playback position as a normalized value between 0.0 and 1.0.

subtitleBackgroundColor

open override var subtitleBackgroundColor: Color

subtitlesEnabled

open override var subtitlesEnabled: Boolean

subtitleTextStyle

open override var subtitleTextStyle: TextStyle

open override var userDragging: Boolean

Denotes whether the user is manually adjusting the playback position.

open override var volume: Float

Controls the playback volume. Valid values are within the range of 0.0 (muted) to 1.0 (maximum volume).

Functions

open override fun clearError()

disableSubtitles

open override fun disableSubtitles()

open override fun dispose()

Releases resources used by the video player and disposes of the state.

open override fun openFile(file: PlatformFile, initializeplayerState: InitialPlayerState)

open override fun openUri(uri: String, initializeplayerState: InitialPlayerState)

Opens a video file or URL for playback.

open override fun pause()

Pauses video playback.

open override fun play()

Starts or resumes video playback.

open override fun seekTo(value: Float)

Seeks to a specific playback position based on the provided normalized value.

selectSubtitleTrack

open override fun selectSubtitleTrack(track: SubtitleTrack?)

open override fun stop()

Stops playback and resets the player state.

toggleFullscreen

open override fun toggleFullscreen()